Versioneer is an application that makes it convenient to edit the ‘vers’ ID 1 (and now 2) resource of a file. It’s also AppleScript-able, so you can write scripts that bulk-change the version of a large number of files.
Why Versioneer?
Some of you are wondering “What’s the ‘vers’ ID 1 resource and why would I care?” A good question. The ‘vers’ ID 1 resource of a file is what the Finder uses to display version information for a file.When you do a “Get Info” on a file, the last field before the “Comments” field is the “Version” field, and the ‘vers’ ID 1 tells the Finder what to put there. Also, if you use “version” in your Finder views, the ‘vers’ ID 1 resource tells the Finder what string to display in the Finder windows as well. Versioneer 1.1 adds the ability to edit ‘vers’ ID 2 resources as well, which tells the Finder what text to display right underneath the file name in the Get Info window.
The power users and developers out there are probably wondering “Why would I need this when I can edit the resource with ResEdit or VersionEdit?” Another good question. ResEdit is slow for this task, since you have to find the ‘vers’, then find the ID you want, then edit. It also doesn’t auto-update the version strings to match the version number, which Versioneer does. VersionEdit does auto-update the strings, but munges the long version string and installs a bunch of other resources that are appropriate only for applications. Also, neither of these applications are scriptable, which Versioneer is. Batch-updating a whole bunch of files is quite convenient if you track your source code version numbers like I do.
OK, cool, how does it work?
You can drag files directly onto Versioneer or open them from the “File” menu. You should then see a window like this one:
A lot, but not all, of this should be fairly self-explanatory. There are usually two ‘vers’ resources associated with a particular file. The ‘vers’ ID 1 resource contains the version information for the file itself while the ID 2 resource contains the version information for the release. In the example above, the file “Appletalk” is version 1.1, but the release is version 2.0.
The “long version string” is what the Finder displays when you do a “get info.” The ID 1 long string is displayed near the bottom of the “get info” window and is labeled “Version:” while the ID 2 long string is displayed immediately underneath the file name, like this:
The ID 1 “short version string” is what appears in the Finder windows if you include “version” in your views, which looks like this:
Many files with ‘vers’ ID 1 resources do not have ‘vers’ ID 2 resources, which is OK.
The only things in Versioneer that are really tricky are the “Auto Update” buttons. When this is checked, Versioneer will automagically update the short string to match the version number. Also, if the initial part of the long string matched the short string, the initial part of the long string will be updated as well. To turn the updating off, simply make sure “Auto Update” is unchecked. There are two “Auto Update” buttons, one for each ‘vers’ ID.
One other piece of information stored in the ‘vers’ resource is something called a “country code.” Country codes provide information about what part of the world the file has been localized for. A list of country codes is provided in the Appendix of this document.
A number of example AppleScripts are included to give you an idea of how to script Versioneer. These scripts should also be useful. If you want to apply a change to a whole bunch of files all at once, scripting is the way to go. Scripting Versioneer is really easy, just take a look at the sample scripts and the dictionary and you should be able to figure it out.
There are some things to watch for:
• Versioneer can open as many files as memory allows; however, if you try to open too many files at once Versioneer will refuse to open more and will beep when you try to do so.
• Apple has clear restrictions on version numbering. Files that do not adhere to these restrictions can cause unusual behavior, so be warned. (Versioneer will warn you when you open such a file just in case you forget this warning.)
• Versioneer will not edit itself while it is running. If you must edit Versioneer itself, make a copy.
• There is a memory leak in Apple’s SFGetFile code, and thus in Versioneer. Nothing I can do about that one except wait for Apple to fix it.
• The numeric fields on the window should only have numbers in them. You can only type numbers in there, but you can paste spaces and non-numeric text. Don’t, as it will mess things up. This is a known PowerPlant bug and I’m sure we won’t have to wait too long for a fix.
Distribution
Versioneer may be distributed freely as long as it is not modified in any way and accompanied by this “ReadMe” document and associated script files. There are some exceptions: (1) services which charge on a per-download basis may not distribute Versioneer; (2) the MicroSoft Network is prohibited from distributing Versioneer. A license to distribute Versioneer is available to the MicroSoft Network for $50,000 and distribution via MSN constitutes acceptance of this license; (3) Jumbo (you know who you are) may not distribute Versioneer. Hint: learn not to spam; and (4) folks who distribute collections of freeware/shareware on CD-ROM must contact me first (don’t worry, I usually say yes but ask for a free copy of the CD-ROM).
The latest version of Versioneer will always be sent to MacGifts and will always be available at the Solar Systems Ltd. FTP site, which is:
<ftp://ftp.cc.gatech.edu/pub/people/byrne/SSL/>.
You will also be able to download Versioneer by visiting the Solar Systems Ltd. web page where you can check out other SSL efforts:
Versioneer is shareware. If you really do use Versioneer, please pay the shareware fee—you’re probably a developer yourself, so you understand the desire to be repaid for programming time. I’m a Ph.D. student and I really should be spending my time on my dissertation, not stuff like this. Your registration will justify this time greatly. Versioneer is U.S. $10 for a single copy (U.S. $5 for students and faculty) or may be site-licensed for U.S. $300. You may pay by cash (any currency), check (in U.S. funds drawn on a U.S. bank), or postal money order (in U.S. funds). If you pay by foreign cash (no coins, please), use the current exchange rate and add about 5% for handling.
Send your name, address, and email address (and photocopy of your student/faculty ID if you’re taking the educational discount) to:
Mike Byrne
Solar Systems Ltd.
1101 Collier Rd. NW, Apt. C-1
Atlanta, GA 30318-8278
U.S.A.
When I receive payment, I will send you a registration code (preferably via email). You can enter the registration code by selecting “About Versioneer” and then clicking on the “Register” button. There you can enter your name, organization, and the registration code.
You may have noticed that Versioneer annoyingly hassles you every time you launch it if you have not entered a valid registration code. It will also expire and refuse to launch after the 30-day trial period is up. Some people call this “annoy-ware” and I understand that. So why does Versioneer do this? Because I received exactly zero cents for Versioneer 1.0. Nothing. Nada. Zilch. Funny, I know it was downloaded because people asked for it to go onto a couple CD-ROMs. Versioneer is shareware, not freeware—it is not free, get it? Solar Systems Ltd. does have some freeware out there, but this is not one such piece. C’mon, I’m a grad student—ten bucks won’t kill you and it’ll do me a world of good.
Registered users will receive email updates when updates are available and my deepest thanks. If you’re a shareware author, I’ll also trade registration for Versioneer for registration of your product.
Technical Notes
Versioneer was written using MetroWerks’ PowerPlant application framework. Thus, it requires a 68020 or better Macintosh and System 7.0 or better. The C++ framework explains the somewhat large disk footprint for such a simple application. It is not PowerPC-native because it really doesn’t do anything compute intensive and the File Manager isn’t native under any current version of the system and the Resource Manager is only native under System 7.5.2+, so making Versioneer native won’t do much. (If enough—like five—people bug me for a PPC-native version, I’ll probably crank one out.)
Contacting the Author
The best way to get a hold of me is via electronic mail, <byrne@cc.gatech.edu>. Please include the string “SSL” in the subject header so my filter will direct your mail correctly. If you don’t have electronic mail, get with the program. No, seriously, contact me via snail mail at the address listed in the “Registration” section.
I really do want to hear about feature requests and undocumented features (err, bugs), so please contact me if you have either. For more information about Solar Systems Ltd., check out the Web page:
Thanks to MetroWerks for the way-cool framework, PowerPlant. Thanks also to Jim Trudeau and the PowerPlant Dream Team for getting me ramped up enough with PowerPlant to make all this happen. Thanks also to The Fixx, The Cure, Nine Inch Nails, Simple Minds, Peter Gabriel, The Police, William Orbit, and a host of other musicians for the quality hacking tunes. Thanks also to my beta testers, especially Dominique Fays, for all the hard work.
Legal Schlock
“First thing we do is kill all the lawyers.” — William Shakespeare
I think it’s a tragedy that a section like this should be necessary, but we live in a society where someone can successfully sue a fast food chain when they spill hot coffee on themselves and a convicted rapist can be out in a mere handful of years earning millions for hitting people in the head. If that isn’t a mess, I don’t know what is. Thus:
All other copyrights are property of their respective holders.
Solar Systems Ltd. and Mike Byrne hereby disclaim all warranties relating to this software, whether express or implied, including without limitation any implied warranties of merchantability or fitness for a particular purpose. Solar Systems Ltd. and Mike Byrne will not be liable for any special, incidental, consequential, indirect or similar damages due to loss of data or any other reason, even if Solar Systems Ltd. and Mike Byrne or an agent of his has been advised of the possibility of such damages. In no event shall Solar Systems Ltd. or Mike Byrne be liable for any damages, regardless of the form of the claim. The person using the software bears all risk as to the quality and performance of the software.
Appendix A. Country Codes
These are in no way guaranteed to be accurate—I borrowed them from ResEdit.
